/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.android.tools.idea.editors.strings.table.filter

import com.android.ide.common.resources.Locale
import javax.swing.Icon

/** Interface for filters that filter columns in the table by [Locale]. */
interface StringResourceTableColumnFilter {
  /** Decides whether to show the column representing the given [locale]. */
  fun include(locale: Locale): Boolean
  /** Returns an [Icon] representing the filter's [Locale], if any. */
  fun getIcon(): Icon? = null
  /** Returns a text description of what the filter does for use in the UI. */
  fun getDescription(): String
}
